Documentation updates.
authorMatthias Clasen <matthiasc@src.gnome.org>
Thu, 11 Dec 2003 23:52:59 +0000 (23:52 +0000)
committerMatthias Clasen <matthiasc@src.gnome.org>
Thu, 11 Dec 2003 23:52:59 +0000 (23:52 +0000)
ChangeLog
ChangeLog.pre-2-10
ChangeLog.pre-2-4
ChangeLog.pre-2-6
ChangeLog.pre-2-8
docs/reference/ChangeLog
docs/reference/gdk/gdk-sections.txt
gdk/gdk.c
gdk/x11/gdkspawn-x11.c

index c2f55eb0a75e0b4333efe255be9745762a9c308a..8cb899c722cf66c041984744bc3d5651d38cd1de 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+Fri Dec 12 00:43:16 2003  Matthias Clasen  <maclas@gmx.de>
+
+       * gdk/gdk.c (gdk_threads_set_lock_functions): 
+       * gdk/x11/gdkspawn-x11.c: Add "Since: 2.4" to doc comments.
+
 Fri Dec 12 00:05:31 2003  Matthias Clasen  <maclas@gmx.de>
 
        * gtk/gtkrange.c (gtk_range_scroll): Fix direction of 
index c2f55eb0a75e0b4333efe255be9745762a9c308a..8cb899c722cf66c041984744bc3d5651d38cd1de 100644 (file)
@@ -1,3 +1,8 @@
+Fri Dec 12 00:43:16 2003  Matthias Clasen  <maclas@gmx.de>
+
+       * gdk/gdk.c (gdk_threads_set_lock_functions): 
+       * gdk/x11/gdkspawn-x11.c: Add "Since: 2.4" to doc comments.
+
 Fri Dec 12 00:05:31 2003  Matthias Clasen  <maclas@gmx.de>
 
        * gtk/gtkrange.c (gtk_range_scroll): Fix direction of 
index c2f55eb0a75e0b4333efe255be9745762a9c308a..8cb899c722cf66c041984744bc3d5651d38cd1de 100644 (file)
@@ -1,3 +1,8 @@
+Fri Dec 12 00:43:16 2003  Matthias Clasen  <maclas@gmx.de>
+
+       * gdk/gdk.c (gdk_threads_set_lock_functions): 
+       * gdk/x11/gdkspawn-x11.c: Add "Since: 2.4" to doc comments.
+
 Fri Dec 12 00:05:31 2003  Matthias Clasen  <maclas@gmx.de>
 
        * gtk/gtkrange.c (gtk_range_scroll): Fix direction of 
index c2f55eb0a75e0b4333efe255be9745762a9c308a..8cb899c722cf66c041984744bc3d5651d38cd1de 100644 (file)
@@ -1,3 +1,8 @@
+Fri Dec 12 00:43:16 2003  Matthias Clasen  <maclas@gmx.de>
+
+       * gdk/gdk.c (gdk_threads_set_lock_functions): 
+       * gdk/x11/gdkspawn-x11.c: Add "Since: 2.4" to doc comments.
+
 Fri Dec 12 00:05:31 2003  Matthias Clasen  <maclas@gmx.de>
 
        * gtk/gtkrange.c (gtk_range_scroll): Fix direction of 
index c2f55eb0a75e0b4333efe255be9745762a9c308a..8cb899c722cf66c041984744bc3d5651d38cd1de 100644 (file)
@@ -1,3 +1,8 @@
+Fri Dec 12 00:43:16 2003  Matthias Clasen  <maclas@gmx.de>
+
+       * gdk/gdk.c (gdk_threads_set_lock_functions): 
+       * gdk/x11/gdkspawn-x11.c: Add "Since: 2.4" to doc comments.
+
 Fri Dec 12 00:05:31 2003  Matthias Clasen  <maclas@gmx.de>
 
        * gtk/gtkrange.c (gtk_range_scroll): Fix direction of 
index f4ecd53bdd936878a236ace947ed7371b695881a..22dd0ee5738b33014317f3fbf0e00f3b229e9be7 100644 (file)
@@ -1,3 +1,8 @@
+Fri Dec 12 00:52:25 2003  Matthias Clasen  <maclas@gmx.de>
+
+       * gdk/gdk-sections.txt: Add the new gdk_spawn_* and
+       gdk_threads_* declarations.
+
 Thu Dec 11 01:57:55 2003  Matthias Clasen  <maclas@gmx.de>
 
        * gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml: Signal documentation
index 6d1058d3e19fc8b308ff43d3b78448dbd90b7a9b..dd4e96343eaaf0957a0f0fa36935e432bb8f1338 100644 (file)
@@ -206,6 +206,11 @@ gdk_screen_get_monitor_at_point
 gdk_screen_get_monitor_at_window
 gdk_screen_broadcast_client_message
 gdk_screen_get_setting
+<SUBSECTION Spawning>
+gdk_spawn_on_screen
+gdk_spawn_on_screen_with_pipes
+gdk_spawn_command_line_on_screen
+
 <SUBSECTION Standard>
 GDK_SCREEN
 GDK_IS_SCREEN
@@ -881,6 +886,11 @@ gdk_threads_init
 gdk_threads_enter
 gdk_threads_leave
 gdk_threads_mutex
+gdk_threads_set_lock_functions
+
+<SUBSECTION Private>
+gdk_threads_lock
+gdk_threads_unlock
 </SECTION>
 
 <SECTION>
index 67faeab40246b0b665104a0799ef2488aed7ec09..c95371b56f70cb4f895230dab8d72a3c418cd3ae 100644 (file)
--- a/gdk/gdk.c
+++ b/gdk/gdk.c
@@ -534,7 +534,7 @@ gdk_threads_init ()
 
 /**
  * gdk_threads_set_lock_functions:
- * @enter_fn:   function called to guard gtk+
+ * @enter_fn:   function called to guard GDK
  * @leave_fn: function called to release the guard
  *
  * Allows the application to replace the standard method that
@@ -556,8 +556,10 @@ gdk_threads_init ()
  *
  * Most threaded GTK+ apps won't need to use this method.
  *
- * This method must be called before gdk_threads_init, and cannot
+ * This method must be called before gdk_threads_init(), and cannot
  * be called multiple times.
+ *
+ * Since: 2.4
  **/
 void
 gdk_threads_set_lock_functions (GCallback enter_fn,
index 262327ef5ea372dc9843a47a0c7881cbb5c396ce..11365f0af941e51c165791b291d298ca4d667283 100644 (file)
@@ -32,15 +32,17 @@ extern char **environ;
 /**
  * gdk_make_spawn_environment_for_screen:
  * @screen: A #GdkScreen
- * @envp: program environment to copy, or NULL to use current environment.
+ * @envp: program environment to copy, or %NULL to use current environment.
  *
  * Returns a modified copy of the program environment @envp (or the current
- * environment if @envp is NULL) with $DISPLAY set such that a launched 
- * application (which calls gdk_display_open()) inheriting this environment
- * would have @screen as its default screen..
+ * environment if @envp is %NULL) with <envar>DISPLAY</envar> set such that 
+ * a launched application (which calls gdk_display_open()) inheriting this 
+ * environment would have @screen as its default screen..
  *
  * Returns: a newly-allocated %NULL-terminated array of strings.
  *          Use g_strfreev() to free it.
+ *
+ * Since: 2.4
  **/
 static gchar **
 gdk_spawn_make_environment_for_screen (GdkScreen  *screen,
@@ -81,11 +83,12 @@ gdk_spawn_make_environment_for_screen (GdkScreen  *screen,
 /**
  * gdk_spawn_on_screen:
  * @screen: a #GdkScreen
- * @working_directory: child's current working directory, or %NULL to inherit parent's
+ * @working_directory: child's current working directory, or %NULL to 
+ *   inherit parent's
  * @argv: child's argument vector
  * @envp: child's environment, or %NULL to inherit parent's
  * @flags: flags from #GSpawnFlags
- * @child_setup: function to run in the child just before <function>exec()</function>
+ * @child_setup: function to run in the child just before exec()
  * @user_data: user data for @child_setup
  * @child_pid: return location for child process ID, or %NULL
  * @error: return location for error
@@ -98,6 +101,8 @@ gdk_spawn_make_environment_for_screen (GdkScreen  *screen,
  * on a specific screen.
  *
  * Return value: %TRUE on success, %FALSE if error is set
+ *
+ * Since: 2.4
  **/
 gboolean
 gdk_spawn_on_screen (GdkScreen             *screen,
@@ -134,16 +139,20 @@ gdk_spawn_on_screen (GdkScreen             *screen,
 /**
  * gdk_spawn_on_screen_with_pipes:
  * @screen: a #GdkScreen
- * @working_directory: child's current working directory, or %NULL to inherit parent's
+ * @working_directory: child's current working directory, or %NULL to 
+ *   inherit parent's
  * @argv: child's argument vector
  * @envp: child's environment, or %NULL to inherit parent's
  * @flags: flags from #GSpawnFlags
- * @child_setup: function to run in the child just before <function>exec()</function>
+ * @child_setup: function to run in the child just before exec()
  * @user_data: user data for @child_setup
  * @child_pid: return location for child process ID, or %NULL
- * @standard_input: return location for file descriptor to write to child's stdin, or %NULL
- * @standard_output: return location for file descriptor to read child's stdout, or %NULL
- * @standard_error: return location for file descriptor to read child's stderr, or %NULL
+ * @standard_input: return location for file descriptor to write to 
+ *   child's stdin, or %NULL
+ * @standard_output: return location for file descriptor to read child's 
+ *   stdout, or %NULL
+ * @standard_error: return location for file descriptor to read child's 
+ *   stderr, or %NULL
  * @error: return location for error
  *
  * Like g_spawn_async_with_pipes(), except the child process is
@@ -155,6 +164,8 @@ gdk_spawn_on_screen (GdkScreen             *screen,
  * on a specific screen.
  *
  * Return value: %TRUE on success, %FALSE if an error was set
+ *
+ * Since: 2.4
  **/
 gboolean
 gdk_spawn_on_screen_with_pipes (GdkScreen            *screen,
@@ -209,6 +220,8 @@ gdk_spawn_on_screen_with_pipes (GdkScreen            *screen,
  * on a specific screen.
  *
  * Return value: %TRUE on success, %FALSE if error is set.
+ *
+ * Since: 2.4
  **/
 gboolean
 gdk_spawn_command_line_on_screen (GdkScreen    *screen,